home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / userbox / publicdomain / gadutil / docs / gadutil_dev.readme next >
Text File  |  1996-07-16  |  17KB  |  387 lines
  1. Short:    GUI creation library - developer archive
  2. Author:   P-O Yliniemi / Staffan Hämälä
  3. Uploader: peoyli@algonet.se (P-O Yliniemi)
  4. Version:  37.8
  5. Type:     dev/gui
  6.  
  7. Some examples may have weird names (for those who don't understand swedish),
  8. and some text files may be in swedish. This will be fixed in a later release.
  9. Contact me if there is any problem using any of the examples or the docs.
  10.  
  11. Two versions of the .library file is available with this developer package.
  12. One is the "normal" library, and the other one prints out a lot of info when
  13. executing a program that uses GadUtil.
  14.  
  15. If you need to use the debug version, rename the normal version in libs:,
  16. copy the debug version to libs, and rename it to gadutil.library. Reverse
  17. this to change back to the normal version. Don't forget to "flush" all
  18. unused libraries or reboot before testing the program again.
  19.  
  20. All necessary files for Asm & C development are included.
  21.  
  22. Changes overview:
  23. ~~~~~~~~~~~~~~~~~
  24. * 37.8  (15-Jul-96)
  25.         Some bug fixes in the new help functions. If 0 was used as data on a GU_HelpText
  26.         tag with a gadget that shows the help text in the window's or screen's title,
  27.         there were some enforcer hits
  28.  
  29.         Deleted the separate autodoc files. Appended some information on the contents of
  30.         the GU_Public structure to the autodocs. More info about SCRTITLE_HELP and
  31.         WINTITLE_HELP was also appended.
  32.  
  33.         Changed the help function so that all gadgets and title bars that are used to
  34.         display help strings is cleared if the mouse pointer is outside all gadgets that
  35.         have help texts.
  36.  
  37. * 37.7  (12-Jul-96)
  38.     Bug fix in the prototype for GU_ChangeStr (two parameters was mixed up).
  39.  
  40.     GU_ChangeStr now works for both STRING_KIND and TEXT_KIND gadgets. If the
  41.     gadget isn't a STRING or TEXT gadget nothing is done.
  42.  
  43.     Bug fix in GU_CoordsInGadBox function. The register D3 was trashed in all
  44.     earlier versions of GU.
  45.  
  46.     Three new tags allows any STRING or TEXT_KIND gadget to show a (localized)
  47.     help text for each gadget in the window. These tags also works with the
  48.     special gadgets (BEVELBOX, LABEL, PROGRESS). The gadgets attached to the
  49.     window is scanned in sequential order. If a BEVELBOX_KIND gadget matches
  50.     the pointer position, this gadget's help string will have the lowest
  51.     priority. If another BEVELBOX is found inside this, the help string for
  52.     that one will be used if there is no gadget inside that box. The help
  53.     text can also be displayed in the window/screen title.
  54.  
  55.     The TEXT_KIND, STRING_KIND, NUMBER_KIND and INTEGER_KIND gadget's current
  56.     value can now be read from the gu_Active field in the structure    that
  57.     gg_UserData points to.
  58.  
  59. * 37.6  (15-Jun-96)
  60.     gu_Active in the structure that gg_UserData points to was not updated
  61.     when using any routine that used GU_SetGadgetAttrsA(). Now it checks
  62.     the gu_Active value to see if it is out of the gadget's limits.
  63.  
  64.     gng_Flags and gng_GadgetText is now cleared before creation of every
  65.     new gadget.
  66.  
  67.     The LAYOUTA_Spacing tag for LISTVIEW_KIND gadgets is now used to
  68.     determine the height of the gadget. If the height of a gadget should
  69.     be about 4 lines (GU_HeightFactor, 4), the height of the gadget is
  70.     calculated to 4*(font height+value of LAYOUTA_Spacing tag). The same
  71.     method is used for the GU_AddHeiLines tag.
  72.  
  73.     Hotkeys for LISTVIEW_KIND gadgets works as they should again. In v37.5
  74.     of GadUtil (and probably some earlier ones), the listview didn't scroll
  75.     down when you selected the next entry.
  76.  
  77.     Inserted pragmas and prototypes for tagcalls (pragmas only for SAS/C).
  78.     It is possible to create stub routines for the tagcalls for other
  79.     compilers by using fd2pragma 2.0.
  80.  
  81.     Inserted links to the include files in the index file for GadUtil.guide.
  82.  
  83. * 37.5  (29-May-96)
  84.     Bug in PROGRESS_KIND gadget removed. If the gadget was set to
  85.     show x/0 (also 0/0), a division by zero was done.
  86.  
  87.     Two new constants added to the include files: GADUTIL_VER and
  88.     GADUTIL_REV.
  89.     
  90.     Bug fixes in test (demo) programs. The FPF_DISKFONT flag in the
  91.     TextAttr structure was unset in all demo programs. Replaced the
  92.     manual version check in the demo programs with the GadUtil function
  93.     GU_CheckVersion. Removed unnecessary IDCMP flags from the demo
  94.     programs and replaced GadTools IDCMP with the GU_MinimumIDCMP tag.
  95.  
  96. * 37.4  (14-May-96)
  97.     Created a new gadget kind: LABEL_KIND. This gadget kind is used
  98.     to place text relative to other gadgets, bevel boxes, and other
  99.     texts. Can use the same type of shadows that the text for the
  100.     bevel box.
  101.  
  102.     Implemented a new function in the library: GU_CloseFont. Works
  103.     like graphics CloseFont, but takes the parameter in A0 instead
  104.     of A1.
  105.  
  106.     Replaced the list sort routine with a new one that sorts better.
  107.  
  108.     Wrote a new document, "GadUtil.index", that have a list over all
  109.     gadutil functions, sorted by what they do. There are also some
  110.     shortcuts to all tags for gadutil's own gadget kinds.
  111.  
  112.     Created two new flags for BEVELBOX_KIND and LABEL_KIND:
  113.     BB_3DTEXT - can be used as a replacement for GUBB_3DText, TRUE
  114.     LB_3DTEXT - can be used as a replacement for GULB_3DText, TRUE
  115.     
  116. * 37.3  (10-May-96)
  117.     Enforcer hits fixed in the code that handles the GU_AdjustLeft
  118.     and GU_AdjustRight tags.
  119.  
  120.     A new function to clear the inner part of a window was added.
  121.  
  122.     A new function to size (and move, if necessary) a window was
  123.     added.
  124.  
  125.     Bug fix in assembly language include file.
  126.  
  127. * 37.2  (02-May-96)
  128.     Started programming in StormC and did some tests with the library,
  129.     noticed that there was a couple of errors in some include files.
  130.  
  131.     GU_UpdateProgress was wrongly specified in the FD/clib files.
  132.     The output of GU_GetGadgetPtr was specified as (struct Gadget *),
  133.     this is now corrected.
  134.  
  135.     Included an example in C that uses the PROGRESS_KIND gadget.
  136.  
  137. * 37.1  (01-May-96)
  138.     IMAGE_KIND gadget bug fix. The color of the unselected image of
  139.     the gadget was wrong, if the image used more than 4 colors.
  140.  
  141. * 37.0  (29-Apr-96)
  142.     A new function that checks the library's revision added.
  143.     Two new tags added: GU_FractWidth and GU_FractHeight. Suggested
  144.     by Morten Amundsen.
  145.  
  146.     Some small bug fixes in 'C' include files (unterminated comments).
  147.     Cleaned up BetterTest.c a bit (removed some {}). Bug fix on the
  148.     last line of the example (GT_ReplyIMsg -> GU_ReplyIMsg).
  149.  
  150.     Added support for StormC in both installer script and include-
  151.     file installer. Created dictionary for StormC, so that all words
  152.     that belongs to GadUtil (functions, tags and constants) is shown
  153.     in another color.
  154.  
  155. * 36.60 (24-Feb-96)
  156.     Uses the screen's font as the gadget font if no GU_DefTextAttr or
  157.     GU_TextAttr tag is used. Bug fix from v36.59. Changed some docs,
  158.     assembled all examples,    changed installation scripts.
  159.  
  160. * 36.59 (06-Jan-96)
  161.     More docs completed (all docs, finally). Bug fix in the GU_AutoWidth,
  162.     GU_AdjustLeft and GU_AdjustRight tags. The underscore character was
  163.     counted as a normal one. This made gadgets without hotkeys one char
  164.     smaller than other gadgets. A new function that sorts one or two
  165.     lists was added. Some new constants added in include files.
  166.     Changed GU_MinimumIDCMP to support hotkeys. Changed PROGRESS_KIND
  167.     to use GU_GadgetText and GU_LocaleText. Uses the screen's font as
  168.     the gadget font if no GU_DefTextAttr or GU_TextAttr tag is used.
  169.  
  170. * 36.58 (01-Jan-96)
  171.     SLIDER_KIND and SCROLLER_KIND gadgets returned wrong result in
  172.     im->Code if the gadget was changes using the hotkey. Bug reported
  173.     by Lucasz Szelag.
  174.  
  175. * 36.57 (10-Dec-95)
  176.     Some more docs finished. A memory loss bug was fixed.
  177.  
  178. * 36.56 (10-Oct-95)
  179.     Changed some routines, so that hotkeys can't be used on disabled
  180.     gadgets. Made it possible to disable IMAGE_KIND, FILE_KIND and
  181.     DRAWER_KIND gadgets.
  182.  
  183. * 36.55 (30-Sep-95)
  184.     Bug fix in the hotkey part of the library. Wrong code were sent back
  185.     when using GU_LabelHotkey with a LISTVIEW_KIND gadget. A new gadget
  186.     kind was created, PROGRESS_KIND.
  187.  
  188. * 36.54 (06-Jul-95)
  189.     Added support for GU_AutoWidth to CYCLE_KIND gadgets.
  190.  
  191. * 36.53 (05-Jul-95) 
  192.     3 new tags and 4 new flags was added for the BEVELBOX_KIND gadget.
  193.     BEVELBOX_KIND gadgets can now have a shadow added to the text in the
  194.     border. The "sun" can be placed in 4 different places. GU_MinimumIDCMP
  195.     tag was added.
  196.  
  197. * 36.52 (25-Jun-95)
  198.     First public release. Some new flags for the BEVELBOX_KIND gadget was
  199.     added. Supports a total of 100 bevelbox kinds.
  200.  
  201.                                           P-O 960715
  202.                                           ~~~~~~~~~~
  203. ------------------------------------------------------------------------------
  204.  
  205.                             GadUtil.library v37.8
  206.                             ~~~~~~~~~~~~~~~~~~~~~
  207.     GadUtil is another gui library which main goal was to make it easy to
  208.     create font sensitive user interfaces. The library has grown away from
  209.     this main goal, and become another useful-routine-library.
  210.  
  211.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  212.     Distribution:
  213.  
  214.         1) Distribution of this library is allowed in two ways:
  215.              ¹) Only the .library file(s)
  216.              ²) The complete distribution
  217.  
  218.         2) Programmers of totally free software can use and distribute this
  219.           library for free.
  220.  
  221.         3) Programmers of Shareware, Licensware, commercial products and other
  222.            programs that the programmer get any kind of profit from shall send
  223.            a fully working (and registered) copy of the program and its docs to
  224.            us. All larger updates of the program should also be sent to us.
  225.           
  226.         4) Programmers of non-free software not covered by 1) and 2) (my Diskware
  227.            concept belongs to this group) shall be treated as in 3) (a fully
  228.            working and registered copy...).
  229.  
  230.         5) All programs (except commercial products in some cases) must state
  231.            that gadutil.library is used. This may be done in either the About
  232.            requester or in the documentation, but best of all in both places.
  233.  
  234.            Demonstration programs for gadutil.library (that includes the full
  235.            source) may be distributed without this note.
  236.  
  237.            Example for inclusion in About requester:
  238.  
  239.                 "This program uses gadutil.library, which
  240.                  is Copyright © 1994-1996 by P-O Yliniemi
  241.                  and Staffan Hämälä."
  242.  
  243.         6) All localized programs that uses this library should include the
  244.            .ct file(s) to allow anyone to translate that program into their
  245.            own language.
  246.  
  247.  
  248.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  249.     Below is a list of some of the main functions covered by this library.
  250.  
  251.     * FAST (NO OR VERY SMALL DIFFERENCE AGAINST GADTOOLS) AND SMALL (LESS THAN 13k).
  252.       WRITTEN IN ASSEMBLY LANGUAGE. NO F*CKING 'C' or any other slow language!
  253.  
  254.     * Font adaptive. Use any of the system fonts and most other fonts for
  255.       gadgets, texts and menus. All gadgets are placed relative to each
  256.       other, but can be placed at absolute positions (needed for the first
  257.       gadget).
  258.  
  259.     * No need to use GIMMEZEROZERO windows, as this is automatically handled
  260.       by the library. If you specify a gadget position of 10,10 the gadget
  261.       will be placed at 10,10 within the window's border.
  262.  
  263.     * Localized. It is really easy to localize all your (new) programs by
  264.       using this library. Functions and macros for creating localized menus
  265.       are supplied.
  266.  
  267.     * Both assembly and 'C' language support. This is one of the things that is
  268.       missing in most of the other gui libraries. Some extra macros are defined
  269.       for assembly language users, and will make the gadget and menu creating
  270.       process even more easy.
  271.  
  272.     * All GadTools gadgets are supported. Some extra functions are provided
  273.       for ListViews. BUTTON_KIND (and IMAGE_KIND) gadgets have some extra tags,
  274.       including a toggle-select option.
  275.  
  276.       6 extended gadget types are handled by the library:
  277.     
  278.         · FILE_KIND     - gadget for selecting a file.
  279.  
  280.         · DRAWER_KIND   - gadget for selecting a drawer. Most programs also
  281.                          use this gadget for file selection.
  282.  
  283.         · IMAGE_KIND    - uses an intuition image for the gadget. Can use
  284.                           different images for selected and non-selected state.
  285.  
  286.         · BEVELBOX_KIND - gadtools bevelboxes, with some extensions. All
  287.                           gadtools bevelboxes are supported (even with v37).
  288.                           Extensions allows text to be placed above, in or below
  289.                           the upper line of the box. All kinds can be inverted.
  290.  
  291.                           New for v36.52: Bevelbox text placement extended.
  292.                           3 new placements available together with the old
  293.                           ones: centered, left adjusted & right adjusted.
  294.  
  295.                           BFT_BUTTON   - GT v37 BUTTON_KIND border
  296.                           BFT_RIDGE    - GT v37 STRING_KIND border
  297.                           BFT_DROPBOX  - GT v39 BBFT_ICONDROPBOX border
  298.                           BFT_HORIZBAR - A horizontal shadowed line
  299.                           BFT_VERTBAR  - A vertical shadowed line
  300.  
  301.                           This makes it a total of 100 bevel box types. The bevel
  302.                           boxes are treated as gadgets by the library, and you
  303.                           can obtain the structure for the bevelbox in the same
  304.                           way as you get the gadget pointer.
  305.  
  306.                           New for v36.53: Added optional shadow on bevel box text.
  307.                           The shadow has a selectable color/pen and the "sun" can
  308.                           be placed in four different positions.
  309.  
  310.         · PROGRESS_KIND - progress indicator gadget. Background and fill color
  311.                           can be selected. Supports values up to 4.294.967.295,
  312.                           but maximum value should not exceed 4.294.967.295/width.
  313.                           v36.55.
  314.  
  315.     · LABEL_KIND    - a text label that can be placed relative to other texts,
  316.               gadgets, bevelboxes and progress indicators.
  317.  
  318.     * Can create the minimum required IDCMP mask so that all gadgets works.
  319.  
  320.     * A new OpenFont (graphics.library and diskfont.library replacement) is supplied.
  321.       This function will open any font (from RAM, ROM or load it from disk).
  322.  
  323.     * Functions for listviews include adding nodes (memory for the string is
  324.       allocated by the function), counting nodes, getting node pointers, clearing
  325.       a listview, attach and detach lists, moving nodes up and down. A function
  326.       that allows you to sort one or two lists is included from v36.59.
  327.  
  328.     * No need to open gadtools.library anymore, since all gadtools functions are
  329.       provided through this library. Some (the most useable) functions from locale
  330.       library are also provided by gadutil.
  331.  
  332.     * Many libraries are opened through gadutil.library, and these library bases
  333.       are available for your own use (you don't have to open or close some libs).
  334.  
  335.     * All gadgets are created using tag lists. Every next gadget will use the
  336.       previous gadgets values as defaults. Only one call to the gadget making
  337.       routine is needed for every gadget list.
  338.  
  339.     * All gadgets can have their own hotkey. No extra work is needed by the
  340.       programmer (only one extra tag).
  341.  
  342.     * All gadgets (and bevelboxes, texts and progress displays) can have a help
  343.       string attached to it. If the pointer is moved above that object, a
  344.       selectable string or text gadget will be used to display the help string.
  345.       The help string can be localized.
  346.  
  347.     * Distributed with lots of examples, mostly in assembly language, but also
  348.       in 'C'.
  349.  
  350.     * Other functions include:
  351.  
  352.         · Status change for toggle select buttons.
  353.  
  354.         · String change for STRING and TEXT_KIND gadgets.
  355.  
  356.         · Disable functions for all gadget kinds (new for 36.56).
  357.  
  358.         · Routines to set up a busy-pointer (available for both v37 and v39). These
  359.           routines also blocks the input to the main window of the program.
  360.  
  361.         · Routine to check if the mouse pointer is within a gadgets box. Useful
  362.           for mouse-position sensitive appwindows.
  363.  
  364.         · Bevelbox and window refreshing functions.
  365.  
  366.     · Functions to clear and size/move windows
  367.  
  368.     * FAST (NO OR VERY SMALL DIFFERENCE AGAINST GADTOOLS) AND SMALL (LESS THAN 13k).
  369.       WRITTEN IN ASSEMBLY LANGUAGE. NO F*CKING 'C' or any other slow language!
  370.  
  371.  
  372.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  373.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  374.         Per-Olof Yliniemi                           Staffan Hämälä
  375.         Box 78                                      Pellovägen 268
  376.         SE-980 61 Tärendö                           SE-957 93 Pello
  377.         SWEDEN                                      SWEDEN
  378.  
  379.         email:                                      email:
  380.           peoyli@algonet.se                           staham@algonet.se
  381.  
  382.         phone:
  383.           +46-(0)978-20522
  384.  
  385.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  386.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  387.